Update Document Metadata Job

Automatically updates document metadata fields in SharePoint libraries based on configurable criteria.

Configuration class: UpdateDocumentMetadataJobCfg

Schedule base: EveryDayScheduleCfg (runs once daily)

Purpose

This job periodically scans document libraries and updates metadata columns on documents that match specified criteria. Useful for:

• Bulk metadata corrections
• Auto-populating derived fields based on document content or location
• Applying metadata standards across matter sites

Configuration

Disabled

• Type: bool?
• Default: —
• Required: No
• Description: Disable this job without removing configuration

AdditionalSearchCriteria

• Type: string
• Default: —
• Required: No
• Description: Additional CAML or search filter criteria to restrict which documents are updated. Leave empty to process all documents matching the default criteria.

ExcludeMatterCodes

• Type: string (list)
• Default: —
• Required: No
• Description: Array of matter codes to exclude from metadata updates. Documents in these matters are skipped.

CurrentState

• Type: UpdateDocumentMetadataJobState
• Default: —
• Required: No
• Description: System-managed — stores current job state

Scheduling Properties

RunTime

• Type: TimeSpan?
• Default: —
• Description: Time of day to run. Example: "02:00:00" for 2 AM (typical for heavy operations).

Example Configuration

{
  "Disabled": false,
  "AdditionalSearchCriteria": "ContentType='Legal Document'",
  "ExcludeMatterCodes": ["TEST001", "SANDBOX"],
  "RunTime": "02:00:00",
  "CurrentState": {}
}

How It Works

1. Job runs once daily at the configured RunTime
2. Scans all document libraries in the provisioning context
3. Identifies documents matching:
   • Default selection criteria (typically all documents)
   • Plus AdditionalSearchCriteria if provided
   • Excluding documents in matters listed in ExcludeMatterCodes
4. Updates metadata columns according to provisioning configuration
5. Tracks state to avoid re-processing

Notes

• Performance: On large document libraries, this job can consume significant server resources. Schedule it during off-hours
• Exclusions: Use ExcludeMatterCodes to protect test/sandbox content from production metadata rules
• Search criteria: AdditionalSearchCriteria uses CAML WHERE syntax or KQL search syntax depending on the SharePoint version

Related

• Global Settings Configuration — global job settings
• Jobs — other background jobs
• Scheduling Jobs — schedule configuration